home *** CD-ROM | disk | FTP | other *** search
/ TOS Silver 2000 / TOS Silver 2000.iso / Tools / JML_SNAP / SNAP_ENG.DOC < prev   
Encoding:
Text File  |  1996-02-11  |  19.0 KB  |  634 lines
  1.                                 Documentation to
  2.                                 JML-Snapshot 5.21
  3.  
  4. Contents
  5.  
  6.   1.      Introduction
  7.  
  8.      1.1. Features
  9.  
  10.      1.2. Legal things
  11.  
  12.      1.3. JML-Snap is shareware!
  13.      
  14.   2.      Installation
  15.  
  16.      2.1. Registration
  17.  
  18.   3.      How to use...
  19.      
  20.      3.1  Drag&Drop
  21.      
  22.   4.      If something doesn't work...  
  23.  
  24.   5.      Some common things
  25.  
  26.   6.      Known bugs
  27.  
  28.   7.      History
  29.  
  30.   8.      Preview
  31.  
  32.   9.      Updates
  33.   
  34.  10 .     Thanks to...
  35.  
  36.  11.      My adress
  37.  
  38.  
  39. 1. Introduction
  40.  
  41. It was one day after the 1992 ATARI trade-fair. I just had connected my 
  42. new graphiccard to my ST and needed a hardcopy.
  43.  
  44. "No Problem! I've got lot's of these programms on disk", I thought to myself.
  45. But none of them was able to support more than 16 colors; the most of them 
  46. couldn't even handle other resolutions than 320x200.
  47.  
  48. So I decided to write it by myself. I think, most of all shareware-
  49. programms were born like this.
  50.  
  51. When using JML-Snapshot first, please klick on the button "Sprache". The 
  52. language will switch to English!
  53.  
  54. 1.1 Features
  55.  
  56. JML-Snapshot allowes you to save any desired part of the screen to disk.
  57. You can choose between following options:
  58.  
  59. - Free choice of the clipping via rubberband or direct cut of a window, 
  60.   the contents of a window or the whole screen.
  61.  
  62. - Output format IFF, (X)IMG or TIFF
  63.  
  64. - Free choice of path and name of the snapshot or use of a standard-folder
  65.  
  66. - Copy the whole screen via Alt-Help
  67.  
  68. The size of the snapshot is not limited at all. Only if you want to save 
  69. the snapshot under a free chosen name, you maust have enough memory left.
  70. JML-Snapshot can save any amount of colors, even Hi and TrueColor.
  71.  
  72.  
  73. 1.2. Legal things
  74.  
  75. JML-Snapshot may be copied and distributed in the unregistred form. 
  76.  
  77. Any distribution of the key or the registred version is strictly 
  78. forbidden!
  79.  
  80. JML-Snapshot is copyrighted, with all rights reserved.
  81.  
  82. There's no liability for any possible damages, that may be caused by 
  83. JML-Snapshot. I just can't even imagine, which damage this may be. 
  84.  
  85.  
  86. 1.3.  JML-Snapshot is shareware
  87.  
  88. JML-Snapshot may be tested by anybody. If you like it, you have to pay
  89. a fee of DM 20,- (or $20,- or £9,-). 
  90.  
  91. To give you a little motivation, there are some features not available in 
  92. the unregistred version:
  93.              - (X)IMG saving only
  94.              - No Hi/TrueColor support
  95.              - no 'Window-snap'
  96.              - no Alt-Help support
  97.  
  98. To register your copy, you just have to pay your fee and send your name 
  99. and adress to the author. Read chapter 2.1 for more information
  100.  
  101.  
  102. 2.      Installation
  103.  
  104.   If you like to use JML-Snapshot as a programm (PRG, APP), then you may 
  105.   copy it anywhere you like. If you want to use it as an accessory (ACC), 
  106.   JML-Snapshot has to reside on your bootpartition/bootdisk.
  107.  
  108.   The name should always be JML_SNAP! Only the extenders ACC, ACX, APP and 
  109.   PRG are supported. If you can resign to save the options, you can name 
  110.   the programm as you please.
  111.  
  112.  
  113. 2.1     Registration
  114.  
  115. People who have payed the fee for JML-Snapshot, will recieve a personal 
  116. key. For that I need the user's name and adress.
  117.  
  118.  
  119. i.  When you've recieved your key, just click on 'Info' in the maindialog 
  120.     and then click on 'register'. Now you may enter your name, adress and 
  121.     the key. If the click on 'OK' causes an alert, there must be something 
  122.     wrong. Please check your data and try again. Otherwise you should have 
  123.     returned to the maindialog. Now you have to click on 'Save' and you're 
  124.     owner of a registred version. A distribution of this version or the 
  125.     key is striktly forbidden!
  126.  
  127. ii. Since v5.10 the registration may be done by use of a registration 
  128.     file. It has to be named as JML_SNAP.REG ans has to reside in the same 
  129.     path as JML-Snapshot!
  130.     
  131.     The file is a simple ASCII text using the following scheme:
  132.     
  133.     Name
  134.     Street
  135.     City
  136.     Key
  137.     
  138.     An example of JML_SNAP.REG belongs to the distribution. 
  139.     
  140.     When sure, that the file is correct, please start JML-Snapshot and 
  141.     kick on 'Info', then klick on 'Register'. If JML-Snapshot found your 
  142.     data to be valid, you just have to save and the registratin is done.
  143.     Otherwise, you'll find yourself in the registration-dialog and you 
  144.     have to follow the instructions described in i.
  145.     
  146.     
  147.      Any distribution of the key or the registred version is strictly 
  148.      forbidden!
  149.  
  150.     
  151.  
  152. 3.      How to use...
  153.  
  154. JML-Snapshot consists of two parts. The snapshotroutine and a dialog to 
  155. configure. 
  156.  
  157. If you start JML_SNAP as a programm under standard-TOS (no multitaking), 
  158. you can only use the dialog. Started under a multitasking OS nothing will 
  159. happen first. You can work with other applications, as you're used to.
  160.  
  161. JML-Snapshot will be activated (under multitasking or as accessory) after 
  162. you've chosen the item in the menu (if you use MagiC! you can find the 
  163. item in MagiC's popup).
  164.  
  165. If you hold one of the shift keys while activating JML-Snapshot, the 
  166. dialog appears. You should do this when using JML-Snapshot first, to 
  167. configure it to your preferencies.
  168.  
  169. When working with a desktop, which can send VA_START, you may doubleclick 
  170. again on JML_SNAP to reach the dialog.
  171.  
  172.  
  173. The dialog:
  174.  
  175.  Field "Saving":
  176.  
  177.   JML-Snapshot has four options to save your screenshot 
  178.  
  179.      Standard:
  180.      
  181.          Your screenshot will always be saved in a standard-folder.
  182.          Read "The standardpath" for more.
  183.          
  184.      Fileselector:
  185.  
  186.           While active (and enough memory free) you can choose name and 
  187.           path of your snapshot via fileselector. Otherwise JML-Snapshot 
  188.           will use standard name and path.
  189.  
  190.       Drag&Drop:
  191.       
  192.           If your OS supports Drag&Drop you can instruct JML-Snapshot to 
  193.           use this feature.
  194.           More of this in chapter "Drag&Drop".
  195.  
  196.       Protocoll:
  197.            A new feature is the Snap-protocoll, which is public yet.
  198.            Since today, it's only used by "Look'n see" (Shareware by 
  199.            Reiner Rosin).
  200.            
  201.             If a protocoll-receiver is installed, the snapshot will be 
  202.             sent immediately to it!
  203.             
  204.             Might be usefull for creating illustrated documentations.
  205.             
  206.             
  207.  Field "Format":
  208.   Choose your favorite output format.
  209.  
  210.  Field "Extra":
  211.  
  212.      Rubberband:
  213.           
  214.           While "Rubberband" is crossed, the snapshot can freely be chosen. 
  215.           Otherwise, the "window-snap" is active. More of this later.
  216.  
  217.     Fix width:
  218.  
  219.           Unfortunately, there are programms, which expect a word-aligned 
  220.           width for IFF and (X)ING pics. This option will blow up your snapshot, 
  221.           to satisfy these programms.
  222.  
  223.    Delay:
  224.           
  225.           If active, you can delay the action of JML-Snapshot. After 
  226.           activating JML_SNAP, nothing will happen, until you press down 
  227.           both shift keys.
  228.           This might be usefull, for bringing up windows, because some 
  229.           OS' always backdrop the upper window when switching to JML_SNAP.
  230.           
  231.    Alt-Help:
  232.           
  233.           TOS was always able to print out a hardcopy by pressing 
  234.           Alt-Help. Sometimes, you'd like to have the hardcopy as a file, 
  235.           instead of printing out.
  236.           
  237.           The advantage of this method is, to save a screencopy to disk, 
  238.           while having a dialog open or dropped down a menu.
  239.           
  240.           If you switch off Alt-Help support, your computer will behave as 
  241.           usual, just as if JML-Snapshot wasn't installed.
  242.           
  243.           IMPORTANT!!! Please read SECURE.TXT!
  244.           
  245.     Overwrite:
  246.  
  247.           You can instruct JML-Snapshot to overwrite existing files.
  248.           When using the fileselctor, JML-Snapshot will always ask befor 
  249.           overwriting!
  250.  
  251.  
  252. - The standardpath:
  253.  
  254.      If you do a snaphot with filelector disabled, JML-Snapshot will save 
  255.      the file to the standardpath, which you can define here. Click on the 
  256.      field containing the path and the fileselector will appear, so you can 
  257.      choose your standardpath.
  258.  
  259.      The arrows on the left and right are for scrolling the path if it's 
  260.      too long for the box.
  261.  
  262.      If not chosen, the path will be used, JML_SNAP was started from.
  263.  
  264. - The buttons:
  265.  
  266.      Info:
  267.  
  268.           The usual infobox appears. From here you can reach the dialog 
  269.           for the registration.
  270.  
  271.      Save:
  272.  
  273.           All parameters will be saved. If JML-Snapshot isn't able to find 
  274.           itself, you may locate it via fileselector.
  275.  
  276.      Language:
  277.           
  278.           You can switch between German and English
  279.           
  280.      Quit:
  281.  
  282.           Quits JML_Snapshot. If you use JML_SNAP as an accessory, this 
  283.           function will be disabled.
  284.      
  285.      Cancel:
  286.  
  287.           Leaves the dialog and abandons all changes.
  288.  
  289.      OK:
  290.           
  291.           Leaves the dialog and takes over all changes.
  292.  
  293.      
  294. If you use JML-Snapshot as a programm under a singletasking TOS, Cancel 
  295. and OK will quit JML-Snapshot! 
  296.  
  297.  
  298.  
  299. The snapshotroutine:
  300.  
  301. The essential function of JML-Snapshot, which depends strongly on 
  302. "Rubberband". 
  303.  
  304. If you start JML-Snapshot with rubberband active, the mousepointer changes 
  305. to a thin cross. Pressing the right mousebutton cancels.
  306. Pressing the left mousebutton sets the mouseposition as the first corner 
  307. of the snapshot rectangle. The mousepointer changes to a pointing hand and 
  308. you can now set the second corner. When you relseae the button, the 
  309. snapshot will be saved.
  310.  
  311. If rubberband is not active, the pointing hand will appear immediately.
  312. Pressing the left mousebutton will activate the "window-snap", which 
  313. means, that the contents of the window under the mousepointer will be 
  314. saved. If there's no window, JML-Snapshot will save the whole screen!
  315.  
  316. Beware, that you can only save the visible clipping of the window!
  317.  
  318. If you've clicked on a window-gadged, the whole window (including the 
  319. gadgeds) will be saved.
  320.  
  321.  
  322. The snapshot will be saved as "SNAP_xx.ext". "xx" represents a number, 
  323. which will be increased for every snapshot. "ext" represents the 
  324. extension "IFF", "IMG" or "TIF", which depends on the output-format.
  325.  
  326. If you have selected "Fileselector", the bitmap will be saved under your 
  327. chosen name and path. The extension will be set automaticly.
  328.  
  329. Because of TOS-specific internals, you maust have enough memory to freely 
  330. choose a name and path. If there isn't enough memory free, JML-Snapshot 
  331. will save to the standard-path and inform you with an alertbox.
  332.  
  333.  
  334. 3.1.    Drag&Drop
  335.  
  336. This is a new way of data-exchange between paralell running applications.
  337. It's available while using
  338.  
  339.   MultiTOS 1.08 (Beta-version only)
  340.   MagiC!3
  341.   Magic!Mac
  342.  
  343. D&D works like this:
  344. You can click on an object (icon, text-clipping, picture-clipping) and 
  345. drag it to an other window, where you drop it. The object will be placed.
  346.  
  347. If you have activated D&D for JML-Snapshot (and there's enough memory 
  348. left) you can only save your snapshot via D&D.
  349.  
  350. Just operate as usual! JML-Snapshot will not save directly or open the 
  351. fileselector; it'll open a small window, including a camera-icon, which 
  352. you can drag&drop to any other window.
  353.  
  354. Anything else depends on your destination-application
  355.  
  356. - The destination doesn't know Drag&Drop:
  357.   JML-Snapshot informs you using an Alertbox
  358.  
  359. - The destination can not use bitmapdata (e.g. CAT or RUFUS):
  360.   JML-Snapshot informs you using an Alertbox
  361.   
  362. - The destination can use bitmapdata (e.g. Zeig's mir or STELLA):
  363.   JML-Snapshot sends the data directly to the destination as a (X)IMG 
  364.   Picture
  365.  
  366. - The destination window represents a path (eg. some deskops)
  367.   The snapshot will be saved as SNAP.xxx (xxx means IFF, IMG or TIF) 
  368.  
  369. - The destination was a printer-icon (e.g. some deskops):
  370.   JML-Snapshot informs you, using an Alertbox, that it isn't able to print
  371.  
  372. - The destination was the clipboard (e.g. some deskops):
  373.   The snapshot will be saved as SCRAP.IMG
  374.  
  375. - The destination was the trashcan (e.g. some deskops):
  376.   JML-Snapshot asks with an alertbox, if you like to abandon the picture 
  377.   (delete) or if you've made a mistake and wish to keep it (go on).
  378.  
  379. If you can't find a destination, able to use the data, you have to close 
  380. the window. JML-Snapshot asks what you want to do now.
  381. The alert is similar to "trashcan" with the option to save via 
  382. fileselector (save).
  383.  
  384.  
  385. 4.      If something doesn't work...  
  386.  
  387. Unfortunately, it's nearly impossible to find all bugs in a programm.
  388. If you find any, please inform me!
  389.  
  390. I need an exact description of the bugs, to reproduce them. 
  391. Please inform me about
  392.  
  393. - Computer (ST, STE, TT, Falcon, etc.)
  394. - Amount of memory
  395. - TOS version
  396. - Multitasking (MTOS, MagiC!, MultiGem)
  397. - installed accessories
  398. - Programms in your AUTO-folder
  399. - Procedure which led to the occured error
  400.  
  401. It's usefull to always send me a disk and the money for P&P. When I've 
  402. fixed the bug, I'll send you a new version immediately.
  403.  
  404.  
  405. 5.      Some common things...
  406.  
  407. A snapshot can take a "long" time, when using 256 or more colors. The VDI has
  408. to transform the data to the "standard-format" which takes it's time. When 
  409. using TIFF output, JML-Snapshot has to transform the data by itself; but 
  410. the assembler-routines are not too slow.
  411.  
  412. Because of this, I do not support data-compression, to save time. In most 
  413. cases you will use the snapshot in an other application, so this won't be 
  414. too bad.
  415.  
  416. JML_SNAP saves the parameters to itself, so you must not use JML-Snapshot 
  417. in compressed form!
  418.  
  419. JML-Snapshot need the AES even when using Alt-Help. It's not possible to 
  420. save a screencopy, when there's no AES! This happens when using TOS or TTP 
  421. programms under single-TOS or when using the MagiC!-Single-mode.
  422.  
  423. If you like to use JML-Snapshot under MagiC! in single-mode, you have to 
  424. unfreeze JML_SNAP. To do so, you have to switch to the task-manager (press 
  425. Ctrl-Alt-Escape) choose JML_SNAP using the cursor-keys and press 'u'.
  426.  
  427.  
  428.  
  429. 6.      Known bugs
  430.  
  431. If you use TOS 1.04 you have to use a patchprogramm or NVDI, because there 
  432. is a bug in the vr_trnsform - routine of TOS 1.04.
  433.  
  434.  
  435. JML-Snapshot was tested under following condition:
  436.  
  437. - Nearly all ST models, ever built by ATARI
  438.   all STE models
  439.   TT 030 
  440.   FALCON 030
  441.   JANUS
  442.   Macintsoh using MagiC!Mac
  443.   
  444. - Turboboards Hypercache, HBS, PAK/2 und PAK/3
  445.   
  446. - TOS 1.04, 2.06, 3.06 and 4.01
  447.  
  448. - MultiTOS 1.01, 1.08, MagiC!2 and MagiC!3
  449.  
  450. - 68000, 68010, 68020, 68030 and 68040 CPU
  451.  
  452. - NVDI 2.01, 2.5, 3.x
  453.  
  454. - With GDOS (NVDI, ATARI-GDOS, AMC-GDOS, FontGDOS)
  455.  
  456. - in ATARI ST Hi, ST Mid, ST Lo, TT Mid, TT Lo and all FALCON graphic modes 
  457.  
  458. - with the following graphiccards
  459.      
  460.      NOVA MEGA 256
  461.      NOVA VME 32k
  462.      NOVA MEGA 16M
  463.      Crazy Dots 
  464.      Crazy Dots II
  465.      MATRIX TC1006     
  466.      Spektrum TC
  467.  
  468.  
  469. 7.      History
  470.  
  471. v <1.0 Internal versions, lots of bugs
  472.  
  473. v1.0   The first public version!
  474.  
  475. v1.1   JML-Snapshot did not restore the mousepointer!
  476.  
  477. v1.2   JML Snapshot is now independant from free memory
  478.        No fileselector.
  479.        The path can be saved in "JML_SNAP.INF"
  480.        Added an install programm
  481.  
  482. v1.3   The path for saving can now be changed and saved.
  483.  
  484. v1.4   JML_SNAP.INF canceled. The standard-path is now saved directly in 
  485.        the accessory.
  486.  
  487. v1.5   vq_color now gives the real, not the desired value
  488.  
  489. v1.6   Fixed a bug concerning multitasking;
  490.        Last PD-version
  491.  
  492. v2.0   JML-Snapshot is shareware! Multitasking supported, the install 
  493.        programm disappeared.
  494.  
  495. v3.00  Internal version of the MK3 series. Lots of bugs.
  496.  
  497. v3.01  First version for registrated users
  498.  
  499. v3.02  Approved recognizing the pressing of the right mousebutton, no more 
  500.        LINE-A calls
  501.  
  502. v3.10  First version written in 'C'. 
  503.  
  504. v3.11  Fixed a bug in the (X)IMG-version
  505.  
  506. v3.12  Internal version, since now, a COOKIE is installed
  507.  
  508. v3.13  Internal version, Hi and TrueColor supported
  509.  
  510. v3.14  First public TC-version, 256-color TIFF are saved much faster
  511.  
  512. v3.15, 
  513. v3.16  Internal version, little bugfixes 
  514.  
  515. v3.17  Changed internal structures
  516.  
  517. v3.18,  
  518. v3.19  Changed internal structures again
  519.  
  520. v3.20  Window-snap was always with gadgets
  521.  
  522. v3.21  Alertboxes for write-error for (X)IMG and TIFF,  too
  523.        Under MagiC! windows will keep their 'topped' status
  524.        While using the fileselector:
  525.         - "SNAP.ext" used as filename, if none is declared
  526.         - Included warning for overwriting existing files
  527.  
  528. v3.30  Included registration.
  529.  
  530. v3.31  Changed internal structures
  531.  
  532. v4.00  New:       - Alt-Help support
  533.                   - Snap-delay
  534.                   - dialogs in English 
  535.       
  536.        Changed:   - Look of the dialogs
  537.                   - Window-Snap now activated while clicking on the 
  538.                     gadgets of a window.
  539.  
  540. v4.01 The unregistred version always saved the whole screene
  541.        
  542. v4.02 Installed as an accessory it was impossible to use Alt-Help 
  543.       directly after reboot
  544.        
  545. v4.03 The snapshot started one line too deep, while using some VDIs
  546.  
  547. v4.04 (X)IMG is now the only outputformat, instead of IFF
  548.  
  549. v5.00 included Drag&Drop
  550.  
  551. v5.01 D&D data-exchange via pipe will now use always (X)IMG
  552.        In case of D&D-timeout the alertbox appeared twice
  553.  
  554. v5.02 XIMG-pictures were saved wrong, when the width exceeded 1016 pixels.
  555.  
  556. v5.10 Removed Install-programm
  557.       Changed dialog (again)
  558.       Snap-protocoll
  559.       Registration via file
  560.       Saving via fileselector even in the unregistrated version
  561.  
  562. v5.20 Named "Fix IFF" to "Fix width" and this now works for (X)IMG too.
  563.  
  564. v5.21 Button 'register' is available again
  565.  
  566.  
  567. 8.      Preview
  568.  
  569. I'd like to hear suggestions anytime. If I find it usefull, I'll implement 
  570. it. But beware, that JML-Snapshot is a small utility and no OS or drawing 
  571. programm!
  572.  
  573.  
  574. 9. Updates
  575.  
  576. Updates for JML-Snapshot are free!
  577.  
  578. How do I get an update?
  579. I'll upload every new version to the MAUS WI2. Uploads to other 
  580. non-commercial BBS' are allowed.
  581.  
  582. You can ask me for an update, too of course
  583.  
  584. Just send me a letter inclusive a disk and money for P&P. That's it.
  585.  
  586.  
  587. 10.      Thanks to...
  588.  
  589. - all betatesters (I can not name all of them)
  590.  
  591. - the authors of the `Profibuch'
  592.  
  593. - Laurenz Prüssner, for some articles in the ST-Magazin
  594.  
  595. - Mike Steffl fot testing, MEMOHELP and lot of PMs
  596.  
  597. - Reiner Rosin for a little assembler-help, "Zeig's mir" and the first bugreport
  598.   since month'.
  599.  
  600. - *MHG* from "Computer Insel" for their great support.
  601.  
  602. - Dieter Fiebelkorn for GEMView
  603.  
  604. - Theo for BANG 2082
  605.  
  606. - Pink Floyd for `The Dark Side Of The Moon'
  607.  
  608. - you, dear reader, because my English is so bad.
  609.  
  610. - last, but not least, thanks to my lady. I'm sitting much too long in 
  611.   front of my computer. Sorry for that babe...
  612.  
  613.  
  614. 11.      My adress 
  615.  
  616. John McLoud
  617. Mozartstraße 1a
  618. 65439 Flörsheim am Main 
  619. Germany
  620.  
  621. via E-Mail:
  622.  
  623.     john_mcoud@wi2.maus.de    (internet)
  624.     John Mcloud @ WI2         (MAUSNET)
  625.  
  626.  
  627.  
  628. Account:
  629.  
  630. Taunussparkasse  BLZ 512 500 00
  631.                  Kto. Nr.: 9 45 02 97
  632.  
  633.  
  634.